home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / ifl / iflBitArray.z / iflBitArray
Encoding:
Text File  |  2002-10-03  |  4.9 KB  |  132 lines
  1.  
  2.  
  3.  
  4. iiiiffffllllBBBBiiiittttAAAArrrrrrrraaaayyyy((((3333))))    IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiiffffllllBBBBiiiittttAAAArrrrrrrraaaayyyy((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiiffffllllBBBBiiiittttAAAArrrrrrrraaaayyyy - limited subscriptable bit array class
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      none, standalone object
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <ifl/iflBitArray.h>
  16.  
  17. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      This class implements a very limited functionality subscriptable bit
  19.      array that is used by the image data type converter (iflConverter).  The
  20.      constructor requires a void* initializer, so a form such as
  21.  
  22.           int from[1024], to[1024];
  23.           iflBitArray f = from, t = to;
  24.  
  25.      declares bit "pointers" referencing the iiiinnnntttt arrays.  The bit array can
  26.      then be accessed with contructs of the form
  27.  
  28.           floatVal = (float)f[i];
  29.  
  30.      and deposits made with statements such as
  31.  
  32.           t[i] = floatVal;    // no cast needed
  33.  
  34.  
  35. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  36.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  37.  
  38.           iflBitArray(void* dp)
  39.  
  40.  
  41.      SSSSuuuubbbbssssccccrrrriiiipppptttteeeedddd aaaacccccccceeeessssssss
  42.  
  43.           iflBitArray& operator[](int idx)
  44.           void operator=(long rhs)
  45.           operator long()
  46.  
  47.  
  48. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  49.      iiiiffffllllBBBBiiiittttAAAArrrrrrrraaaayyyy(((())))
  50.  
  51.           iflBitArray(void* dp)
  52.  
  53.  
  54.           Constructs a bit "pointer" that accesses the bit array pointed to by
  55.           _d_p.  Use the subscript operator to access elements of the array off
  56.           this pseudo-pointer on either the left-hand or right-hand side of an
  57.           assignment.
  58.  
  60.  
  61.  
  62.                                                                         PPPPaaaaggggeeee 1111
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69. iiiiffffllllBBBBiiiittttAAAArrrrrrrraaaayyyy((((3333))))    IIIImmmmaaaaggggeeee FFFFoooorrrrmmmmaaaatttt LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll     iiiiffffllllBBBBiiiittttAAAArrrrrrrraaaayyyy((((3333))))
  70.  
  71.  
  72.  
  73.      ooooppppeeeerrrraaaattttoooorrrr[[[[]]]]
  74.  
  75.           iflBitArray& operator[](int idx)
  76.  
  77.  
  78.           The subscript operator stores the byte and bit offsets needed to
  79.           access the element specified by _i_d_x. This function returns a self-
  80.           reference so the real work can be done with the cast and assigment
  81.           operators for this class.  It works with certain restrictions noted
  82.           below.
  83.  
  84.      ooooppppeeeerrrraaaattttoooorrrr====
  85.  
  86.           void operator=(long rhs)
  87.  
  88.  
  89.           The assignment operator clears or sets the bit pointed to by the
  90.           left-hand side of the assigment.  The bit is set if _r_h_s is nonzero,
  91.           otherwise it is cleared.  By only allowing a long for the right-hand
  92.           side, a bit subscript on the right is automatically extracted by
  93.           going through the cast operator.  C++ converts other types such as
  94.           ffffllllooooaaaatttt and sssshhhhoooorrrrtttt to lllloooonnnngggg without complaining.
  95.  
  96.      ooooppppeeeerrrraaaattttoooorrrr lllloooonnnngggg
  97.  
  98.           operator long()
  99.  
  100.  
  101.           The cast operator extracts the (previously remembered) subscripted
  102.           bit.  Again, C++ fills in all the other type conversions.
  103.  
  104. NNNNOOOOTTTTEEEESSSS
  105.      Due to limitations of the implementation, the same bit "pointer" must not
  106.      occur twice in the same assignment (with different subscripts):
  107.  
  108.           t[i] = ~(long)t[j];  // bogus result (depends on order of evaluation)
  109.           t[i] = f[j];   // ok even if 't' and 'f' point to same data array
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.                                                                         PPPPaaaaggggeeee 2222
  129.  
  130.  
  131.  
  132.